<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>ListCacheKeyGenerator xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/com/googlecode/ehcache/annotations/key/ListCacheKeyGenerator.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> * Copyright 2010-2011 Nicholas Blair, Eric Dalquist</em>
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> * you may not use this file except in compliance with the License.</em>
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_javadoccomment"> * You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_javadoccomment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> com.googlecode.ehcache.annotations.key;
<a class="jxr_linenumber" name="17" href="#17">17</a>  
<a class="jxr_linenumber" name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> java.lang.reflect.Array;
<a class="jxr_linenumber" name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.util.Collection;
<a class="jxr_linenumber" name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.util.LinkedList;
<a class="jxr_linenumber" name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="23" href="#23">23</a>  
<a class="jxr_linenumber" name="24" href="#24">24</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * @author Eric Dalquist</em>
<a class="jxr_linenumber" name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * @version $Revision: 692 $</em>
<a class="jxr_linenumber" name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="28" href="#28">28</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/ListCacheKeyGenerator.html">ListCacheKeyGenerator</a> <strong class="jxr_keyword">extends</strong> AbstractDeepCacheKeyGenerator&lt;ListCacheKeyGenerator.ListKeyGenerator, ReadOnlyList&lt;?&gt;&gt; {
<a class="jxr_linenumber" name="29" href="#29">29</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment">     * Name of the bean this generator is registered under using the default constructor.</em>
<a class="jxr_linenumber" name="31" href="#31">31</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="32" href="#32">32</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_BEAN_NAME = <span class="jxr_string">"com.googlecode.ehcache.annotations.key.ListCacheKeyGenerator.DEFAULT_BEAN_NAME"</span>;
<a class="jxr_linenumber" name="33" href="#33">33</a>      
<a class="jxr_linenumber" name="34" href="#34">34</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/ListCacheKeyGenerator.html">ListKeyGenerator</a> {
<a class="jxr_linenumber" name="35" href="#35">35</a>          <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> LinkedList&lt;ArrayList&lt;Object&gt;&gt; keyStack = <strong class="jxr_keyword">new</strong> LinkedList&lt;ArrayList&lt;Object&gt;&gt;();
<a class="jxr_linenumber" name="36" href="#36">36</a>          <strong class="jxr_keyword">private</strong> ArrayList&lt;Object&gt; current;
<a class="jxr_linenumber" name="37" href="#37">37</a>          
<a class="jxr_linenumber" name="38" href="#38">38</a>          <strong class="jxr_keyword">private</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/ListCacheKeyGenerator.html">ListKeyGenerator</a>() {
<a class="jxr_linenumber" name="39" href="#39">39</a>          }
<a class="jxr_linenumber" name="40" href="#40">40</a>      }
<a class="jxr_linenumber" name="41" href="#41">41</a>      
<a class="jxr_linenumber" name="42" href="#42">42</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment">     * @see AbstractCacheKeyGenerator#AbstractCacheKeyGenerator() </em>
<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="45" href="#45">45</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/ListCacheKeyGenerator.html">ListCacheKeyGenerator</a>() {
<a class="jxr_linenumber" name="46" href="#46">46</a>      }
<a class="jxr_linenumber" name="47" href="#47">47</a>  
<a class="jxr_linenumber" name="48" href="#48">48</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment">     * @see AbstractCacheKeyGenerator#AbstractCacheKeyGenerator(boolean, boolean) </em>
<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="51" href="#51">51</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/ListCacheKeyGenerator.html">ListCacheKeyGenerator</a>(<strong class="jxr_keyword">boolean</strong> includeMethod, <strong class="jxr_keyword">boolean</strong> includeParameterTypes) {
<a class="jxr_linenumber" name="52" href="#52">52</a>          <strong class="jxr_keyword">super</strong>(includeMethod, includeParameterTypes);
<a class="jxr_linenumber" name="53" href="#53">53</a>      }
<a class="jxr_linenumber" name="54" href="#54">54</a>  
<a class="jxr_linenumber" name="55" href="#55">55</a>      @Override
<a class="jxr_linenumber" name="56" href="#56">56</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/ListCacheKeyGenerator.html">ListKeyGenerator</a> getGenerator(Object... data) {
<a class="jxr_linenumber" name="57" href="#57">57</a>          <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/ListCacheKeyGenerator.html">ListKeyGenerator</a>();
<a class="jxr_linenumber" name="58" href="#58">58</a>      }
<a class="jxr_linenumber" name="59" href="#59">59</a>      
<a class="jxr_linenumber" name="60" href="#60">60</a>      @Override
<a class="jxr_linenumber" name="61" href="#61">61</a>      <strong class="jxr_keyword">public</strong> ReadOnlyList&lt;?&gt; generateKey(<a href="../../../../../com/googlecode/ehcache/annotations/key/ListCacheKeyGenerator.html">ListKeyGenerator</a> generator) {
<a class="jxr_linenumber" name="62" href="#62">62</a>          <strong class="jxr_keyword">final</strong> ArrayList&lt;Object&gt; key = generator.keyStack.getFirst();
<a class="jxr_linenumber" name="63" href="#63">63</a>          <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ReadOnlyList&lt;Object&gt;(key);
<a class="jxr_linenumber" name="64" href="#64">64</a>      }
<a class="jxr_linenumber" name="65" href="#65">65</a>      
<a class="jxr_linenumber" name="66" href="#66">66</a>      @Override
<a class="jxr_linenumber" name="67" href="#67">67</a>      <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> beginRecursion(<a href="../../../../../com/googlecode/ehcache/annotations/key/ListCacheKeyGenerator.html">ListKeyGenerator</a> generator, Object e) {
<a class="jxr_linenumber" name="68" href="#68">68</a>          <em class="jxr_comment">//Track the previous list</em>
<a class="jxr_linenumber" name="69" href="#69">69</a>          <strong class="jxr_keyword">final</strong> ArrayList&lt;Object&gt; previous = generator.current;
<a class="jxr_linenumber" name="70" href="#70">70</a>          
<a class="jxr_linenumber" name="71" href="#71">71</a>          <em class="jxr_comment">//Create the new list doing best effort to create it with the correct size</em>
<a class="jxr_linenumber" name="72" href="#72">72</a>          <strong class="jxr_keyword">if</strong> (e.getClass().isArray()) {
<a class="jxr_linenumber" name="73" href="#73">73</a>              <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> size = Array.getLength(e);
<a class="jxr_linenumber" name="74" href="#74">74</a>              generator.current = <strong class="jxr_keyword">new</strong> ArrayList&lt;Object&gt;(size);
<a class="jxr_linenumber" name="75" href="#75">75</a>          }
<a class="jxr_linenumber" name="76" href="#76">76</a>          <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (e instanceof Collection&lt;?&gt;) {
<a class="jxr_linenumber" name="77" href="#77">77</a>              <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> size = ((Collection&lt;?&gt;)e).size();
<a class="jxr_linenumber" name="78" href="#78">78</a>              generator.current = <strong class="jxr_keyword">new</strong> ArrayList&lt;Object&gt;(size);
<a class="jxr_linenumber" name="79" href="#79">79</a>          }
<a class="jxr_linenumber" name="80" href="#80">80</a>          <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (e instanceof Map.Entry&lt;?, ?&gt;) {
<a class="jxr_linenumber" name="81" href="#81">81</a>              generator.current = <strong class="jxr_keyword">new</strong> ArrayList&lt;Object&gt;(2);
<a class="jxr_linenumber" name="82" href="#82">82</a>          }
<a class="jxr_linenumber" name="83" href="#83">83</a>          <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="84" href="#84">84</a>              generator.current = <strong class="jxr_keyword">new</strong> ArrayList&lt;Object&gt;();
<a class="jxr_linenumber" name="85" href="#85">85</a>          }
<a class="jxr_linenumber" name="86" href="#86">86</a>          
<a class="jxr_linenumber" name="87" href="#87">87</a>          <em class="jxr_comment">//Stick the new list on the stack</em>
<a class="jxr_linenumber" name="88" href="#88">88</a>          generator.keyStack.addFirst(generator.current);
<a class="jxr_linenumber" name="89" href="#89">89</a>          
<a class="jxr_linenumber" name="90" href="#90">90</a>          <em class="jxr_comment">//If there was a previous list add the new list to it</em>
<a class="jxr_linenumber" name="91" href="#91">91</a>          <strong class="jxr_keyword">if</strong> (previous != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="92" href="#92">92</a>              previous.add(generator.current);
<a class="jxr_linenumber" name="93" href="#93">93</a>          }
<a class="jxr_linenumber" name="94" href="#94">94</a>      }
<a class="jxr_linenumber" name="95" href="#95">95</a>  
<a class="jxr_linenumber" name="96" href="#96">96</a>      @Override
<a class="jxr_linenumber" name="97" href="#97">97</a>      <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> endRecursion(<a href="../../../../../com/googlecode/ehcache/annotations/key/ListCacheKeyGenerator.html">ListKeyGenerator</a> generator, Object e) {
<a class="jxr_linenumber" name="98" href="#98">98</a>          <strong class="jxr_keyword">if</strong> (generator.keyStack.size() &gt; 1) {
<a class="jxr_linenumber" name="99" href="#99">99</a>              generator.keyStack.removeFirst();
<a class="jxr_linenumber" name="100" href="#100">100</a>             generator.current = generator.keyStack.peek();
<a class="jxr_linenumber" name="101" href="#101">101</a>         }
<a class="jxr_linenumber" name="102" href="#102">102</a>     }
<a class="jxr_linenumber" name="103" href="#103">103</a> 
<a class="jxr_linenumber" name="104" href="#104">104</a>     @Override
<a class="jxr_linenumber" name="105" href="#105">105</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> appendGraphCycle(<a href="../../../../../com/googlecode/ehcache/annotations/key/ListCacheKeyGenerator.html">ListKeyGenerator</a> generator, Object o) {
<a class="jxr_linenumber" name="106" href="#106">106</a>         <strong class="jxr_keyword">this</strong>.append(generator, (Object)<strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="107" href="#107">107</a>     }
<a class="jxr_linenumber" name="108" href="#108">108</a> 
<a class="jxr_linenumber" name="109" href="#109">109</a>     @Override
<a class="jxr_linenumber" name="110" href="#110">110</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> appendNull(<a href="../../../../../com/googlecode/ehcache/annotations/key/ListCacheKeyGenerator.html">ListKeyGenerator</a> generator) {
<a class="jxr_linenumber" name="111" href="#111">111</a>         <strong class="jxr_keyword">this</strong>.append(generator, (Object)<strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="112" href="#112">112</a>     }
<a class="jxr_linenumber" name="113" href="#113">113</a> 
<a class="jxr_linenumber" name="114" href="#114">114</a>     @Override
<a class="jxr_linenumber" name="115" href="#115">115</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> append(<a href="../../../../../com/googlecode/ehcache/annotations/key/ListCacheKeyGenerator.html">ListKeyGenerator</a> generator, Object e) {
<a class="jxr_linenumber" name="116" href="#116">116</a>         <strong class="jxr_keyword">if</strong> (generator.current == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="117" href="#117">117</a>             <strong class="jxr_keyword">this</strong>.beginRecursion(generator, e);
<a class="jxr_linenumber" name="118" href="#118">118</a>         }
<a class="jxr_linenumber" name="119" href="#119">119</a>         
<a class="jxr_linenumber" name="120" href="#120">120</a>         generator.current.add(e);
<a class="jxr_linenumber" name="121" href="#121">121</a>     }
<a class="jxr_linenumber" name="122" href="#122">122</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

